Skip to content

Update PR docs#1540

Merged
tk-o merged 10 commits intomainfrom
update-pr-docs
Jan 19, 2026
Merged

Update PR docs#1540
tk-o merged 10 commits intomainfrom
update-pr-docs

Conversation

@lightwalker-eth
Copy link
Member

@lightwalker-eth lightwalker-eth commented Jan 16, 2026 •
edited
Loading

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

  • Updated docs on pull requests
  • Moved ideas that are docs about pull requests out of the "Lite" PR template and into the docs site.
  • Linked to docs site details about PR processes from the "Lite" PR template.

Why

  • Consolidate & improve explicit docs on our PR processes.

Testing

  • Not relevant.

Pre-Review Checklist (Blocking)

  • This PR does not introduce significant changes and is low-risk to review quickly.
  • Relevant changesets are included (or are not required)

Copilot AI review requested due to automatic review settings January 16, 2026 19:15
@vercel
Copy link
Contributor

vercel bot commented Jan 16, 2026 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
admin.ensnode.io Ready Ready Preview, Comment Jan 16, 2026 8:00pm
ensnode.io Ready Ready Preview, Comment Jan 16, 2026 8:00pm
ensrainbow.io Ready Ready Preview, Comment Jan 16, 2026 8:00pm

@changeset-bot
Copy link

changeset-bot bot commented Jan 16, 2026 •
edited
Loading

⚠️ No Changeset found

Latest commit: c0ed3ce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI reviewed Jan 16, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR consolidates and improves documentation for the ENSNode pull request process by moving detailed guidance from PR templates into dedicated documentation pages on the ENSNode docs site.

Changes:

  • Created a new dedicated PR documentation page (prs.mdx) covering PR templates, standard PR process, changesets, and PR description checks
  • Reorganized the releases documentation by removing changeset instructions and renaming from "Contributing to Releases" to "Creating a Release"
  • Simplified the Lite PR template by removing the tips section and adding a link to the new comprehensive PR documentation

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
docs/ensnode.io/src/content/docs/docs/contributing/prs.mdx New documentation page covering pull request processes, templates, and changeset guidelines
docs/ensnode.io/src/content/docs/docs/contributing/releases.mdx Removed changeset instructions (moved to prs.mdx), updated title and sidebar order
.github/pull_request_template.md Added link to PR documentation, removed inline tips section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings January 16, 2026 19:34
@lightwalker-eth lightwalker-eth marked this pull request as ready for review January 16, 2026 19:36
@lightwalker-eth lightwalker-eth requested a review from a team as a code owner January 16, 2026 19:36
Copilot AI reviewed Jan 16, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Jan 16, 2026 •
edited
Loading

Greptile Summary

Consolidated PR process documentation by moving content from the Lite PR template into dedicated documentation pages. The PR template now links to comprehensive docs covering PR workflows, changesets, and release processes.

Key changes:

  • Added link to new PR documentation at top of Lite PR template
  • Created new prs.mdx documentation with comprehensive PR process details, changeset guidelines, and logical change criteria
  • Moved changeset instructions from releases.mdx to prs.mdx for better organization
  • Updated releases.mdx to focus solely on release types and selection

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk
  • Documentation-only changes that improve organization and accessibility of PR/release process information. No code logic affected, no security implications, and changes are well-structured.
  • No files require special attention

Important Files Changed

Filename Overview
.github/pull_request_template.md Removed collapsible tips section and added link to comprehensive PR documentation site
docs/ensnode.io/src/content/docs/docs/contributing/prs.mdx New comprehensive PR documentation covering templates, process, changesets, and description checks
docs/ensnode.io/src/content/docs/docs/contributing/releases.mdx Updated title, sidebar order, and removed changeset instructions (moved to prs.mdx)

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Template as PR Template
    participant Docs as Documentation Site
    participant Bot as Changesets Bot
    
    Dev->>Template: Opens PR using Lite template
    Template->>Docs: Links to comprehensive PR docs
    Dev->>Docs: Reviews PR process guidelines
    Docs->>Dev: Shows changeset criteria & instructions
    Dev->>Dev: Runs `pnpm changeset`
    Dev->>Template: Completes PR checklist
    Template->>Bot: Validates checkboxes
    Bot->>Dev: Comments with changeset confirmation
    Dev->>Docs: References release selection guide
    Docs->>Dev: Explains Full/Snapshot/Preview releases
Loading

greptile-apps[bot]
greptile-apps bot reviewed Jan 16, 2026
View reviewed changes
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

Copilot AI review requested due to automatic review settings January 16, 2026 19:48
Copilot AI reviewed Jan 16, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@lightwalker-eth
Copy link
Member Author

lightwalker-eth commented Jan 16, 2026

@greptile

lightwalker-eth
lightwalker-eth commented Jan 16, 2026
View reviewed changes
Copy link
Member Author

@lightwalker-eth lightwalker-eth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self review completed

tk-o
tk-o approved these changes Jan 19, 2026
View reviewed changes
Copy link
Contributor

@tk-o tk-o left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tk-o tk-o merged commit d8ba6a4 into main Jan 19, 2026
12 checks passed
@tk-o tk-o deleted the update-pr-docs branch January 19, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@tk-o tk-o tk-o approved these changes

+1 more reviewer

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@lightwalker-eth @tk-o